Other Constants
The following constants are available globally.
-
An
NSNumberobject containing a Boolean value; specifies whether the shape of anDingiComputedShapeSourceshould be wrapped to accomodate coordinates with longitudes beyond −180 and 180. The default value isNO.Setting this option to
YESaffects rendering performance.This option is used with the
DingiComputedShapeSourceclass; it is ignored when creating anDingiShapeSourceobject.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionWrapsCoordinatesSwift
static let wrapsCoordinates: DingiShapeSourceOption -
An
NSNumberobject containing a Boolean value; specifies whether the shape of anDingiComputedShapeSourceshould be clipped at the edge of each tile. The default value isNO.Setting this option to
YESaffects rendering performance. Use this option to clipDingiPolylines andDingiPolygons at tile boundaries without artifacts.This option is used with the
DingiComputedShapeSourceclass; it is ignored when creating anDingiShapeSourceobject.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionClipsCoordinatesSwift
static let clipsCoordinates: DingiShapeSourceOption
-
Posted by the shared
DingiOfflineStorageobject when anDingiOfflinePackobject’s progress changes. The progress may change due to a resource being downloaded or because the pack discovers during the download that more resources are required for offline viewing. This notification is posted whenever any field in theprogressproperty changes.The
objectis theDingiOfflinePackobject whose progress changed. TheuserInfodictionary contains the pack’s current state in theDingiOfflinePackStateUserInfoKeykey and details about the pack’s current progress in theDingiOfflinePackProgressUserInfoKeykey. You may also consult theDingiOfflinePack.stateandDingiOfflinePack.progressproperties, which provide the same values.If you only need to observe changes in a particular pack’s progress, you can alternatively observe KVO change notifications to the pack’s
progresskey path.Declaration
Objective-C
extern const NSNotificationName _Nonnull DingiOfflinePackProgressChangedNotificationSwift
static let DingiOfflinePackProgressChanged: NSNotification.Name -
Posted by the shared
DingiOfflineStorageobject whenever anDingiOfflinePackobject encounters an error while downloading. The error may be recoverable and may not warrant the user’s attention. For example, the pack’s implementation may attempt to re-request failed resources based on an exponential backoff strategy or upon the restoration of network access.The
objectis theDingiOfflinePackobject that encountered the error. TheuserInfodictionary contains the error object in theDingiOfflinePackErrorUserInfoKeykey.Declaration
Objective-C
extern const NSNotificationName _Nonnull DingiOfflinePackErrorNotificationSwift
static let DingiOfflinePackError: NSNotification.Name -
Posted by the shared
DingiOfflineStorageobject when the maximum number of tiles has been downloaded and stored on the current device.The
objectis theDingiOfflinePackobject that reached the tile limit in the course of downloading. TheuserInfodictionary contains the tile limit in theDingiOfflinePackMaximumCountUserInfoKeykey.Once this limit is reached, no instance of
DingiOfflinePackcan download additional tiles from Dingi APIs until already downloaded tiles are removed by calling the-[DingiOfflineStorage removePack:withCompletionHandler:]method. Contact your Dingi sales representative to have the limit raised.Declaration
Objective-C
extern const NSNotificationName _Nonnull DingiOfflinePackMaximumDingiTilesReachedNotificationSwift
static let DingiOfflinePackMaximumDingiTilesReached: NSNotification.Name -
The key for an
NSNumberobject that indicates an offline pack’s current state. This key is used in theuserInfodictionary of anDingiOfflinePackProgressChangedNotificationnotification. Call-integerValueon the object to receive theDingiOfflinePackState-typed state.Declaration
Objective-C
extern const DingiOfflinePackUserInfoKey _Nonnull DingiOfflinePackUserInfoKeyStateSwift
static let state: DingiOfflinePackUserInfoKey -
The key for an
NSValueobject that indicates an offline pack’s current progress. This key is used in theuserInfodictionary of anDingiOfflinePackProgressChangedNotificationnotification. Call-DingiOfflinePackProgressValueon the object to receive theDingiOfflinePackProgress-typed progress.Declaration
Objective-C
extern const DingiOfflinePackUserInfoKey _Nonnull DingiOfflinePackUserInfoKeyProgressSwift
static let progress: DingiOfflinePackUserInfoKey -
The key for an
NSErrorobject that is encountered in the course of downloading an offline pack. This key is used in theuserInfodictionary of anDingiOfflinePackErrorNotificationnotification. The error’s domain isDingiErrorDomain. SeeDingiErrorCodefor possible error codes.Declaration
Objective-C
extern const DingiOfflinePackUserInfoKey _Nonnull DingiOfflinePackUserInfoKeyErrorSwift
static let error: DingiOfflinePackUserInfoKey -
The key for an
NSNumberobject that indicates the maximum number of Dingi-hosted tiles that may be downloaded and stored on the current device. This key is used in theuserInfodictionary of anDingiOfflinePackMaximumDingiTilesReachedNotificationnotification. Call-unsignedLongLongValueon the object to receive theuint64_t-typed tile limit.Declaration
Objective-C
extern const DingiOfflinePackUserInfoKey _Nonnull DingiOfflinePackUserInfoKeyMaximumCountSwift
static let maximumCount: DingiOfflinePackUserInfoKey
-
An
NSNumberobject containing an unsigned integer that specifies the encoding formula for raster-dem tilesets. The integer corresponds to one of the constants described inDingiDEMEncoding.The default value for this option is
DingiDEMEncodingMapbox.This option cannot be represented in a TileJSON or style JSON file. It is used with the
DingiRasterDEMSourceclass and is ignored when creating anDingiRasterTileSourceorDingiVectorTileSourceobject.Declaration
Objective-C
extern const DingiTileSourceOption DingiTileSourceOptionDEMEncodingSwift
static let demEncoding: DingiTileSourceOption
-
An
NSNumberobject containing a floating-point number that specifies the width and height (measured in points) at which the map displays each raster image tile when the map’s zoom level is an integer. The raster tile source scales its images up or down when the map’s zoom level falls between two integers.The default value for this option is 512. Version 4 of the Mapbox Maps API requires a value of 256, as do many third-party tile servers, so consult your provider’s documentation for the correct value.
This option is only applicable to
DingiRasterTileSourceobjects; it is ignored when initializingDingiVectorTileSourceobjects.Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionTileSizeSwift
static let tileSize: DingiTileSourceOption
-
An
NSNumberobject containing a Boolean enabling or disabling clustering. If theshapeproperty contains point shapes, setting this option toYESclusters the points by radius into groups. The default value isNO.This option only affects point features within an
DingiShapeSourceobject; it is ignored when creating anDingiComputedShapeSourceobject.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionClusteredSwift
static let clustered: DingiShapeSourceOption -
An
NSNumberobject containing an integer; specifies the radius of each cluster if clustering is enabled. A value of 512 produces a radius equal to the width of a tile. The default value is 50.This option only affects point features within an
DingiShapeSourceobject; it is ignored when creating anDingiComputedShapeSourceobject.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionClusterRadiusSwift
static let clusterRadius: DingiShapeSourceOption -
An
NSNumberobject containing an integer; specifies the maximum zoom level at which to cluster points if clustering is enabled. Defaults to one zoom level less than the value ofDingiShapeSourceOptionMaximumZoomLevelso that, at the maximum zoom level, the shapes are not clustered.This option only affects point features within an
DingiShapeSourceobject; it is ignored when creating anDingiComputedShapeSourceobject.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionMaximumZoomLevelForClusteringSwift
static let maximumZoomLevelForClustering: DingiShapeSourceOption -
An
NSNumberobject containing an integer; specifies the minimum zoom level at which to create vector tiles. The default value is 0.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionMinimumZoomLevelSwift
static let minimumZoomLevel: DingiShapeSourceOption -
An
NSNumberobject containing an integer; specifies the maximum zoom level at which to create vector tiles. A greater value produces greater detail at high zoom levels. The default value is 18.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionMaximumZoomLevelSwift
static let maximumZoomLevel: DingiShapeSourceOption -
An
NSNumberobject containing an integer; specifies the size of the tile buffer on each side. A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself. Larger values produce fewer rendering artifacts near tile edges and slower performance. The default value is 128.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionBufferSwift
static let buffer: DingiShapeSourceOption -
An
NSNumberobject containing a double; specifies the Douglas-Peucker simplification tolerance. A greater value produces simpler geometries and improves performance. The default value is 0.375.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionSimplificationToleranceSwift
static let simplificationTolerance: DingiShapeSourceOption -
An
NSNumberobject containing a Boolean enabling or disabling calculating line distance metrics.Set this property to
YESin order for theDingiLineStyleLayer.lineGradientproperty to have its intended effect. The default value isNO.Declaration
Objective-C
extern const DingiShapeSourceOption _Nonnull DingiShapeSourceOptionLineDistanceMetricsSwift
static let lineDistanceMetrics: DingiShapeSourceOption
-
A version number identifying the default version of the Mapbox Streets style obtained through the
-streetsStyleURLmethod. This version number may also be passed into the-streetsStyleURLWithVersion:method.The value of this constant generally corresponds to the latest released version as of the date on which this SDK was published. You can use this constant to ascertain the style used by
DingiMapViewandDingiTilePyramidOfflineRegionwhen no style URL is specified. Consult the Mapbox Styles API documentation for the most up-to-date style versioning information.Warning
The value of this constant may change in a future release of the SDK. If you use any feature that depends on a specific aspect of a default style – for instance, the minimum zoom level that includes roads – you may use the current value of this constant or the underlying style URL, but do not use the constant itself. Such details may change significantly from version to version.Declaration
Objective-C
static const NSInteger DingiStyleDefaultVersion = 10Swift
let DingiStyleDefaultVersion: Int
-
An
NSNumberobject containing an unsigned integer that specifies the minimum zoom level at which to display tiles from the source.The value should be between 0 and 22, inclusive, and less than
DingiTileSourceOptionMaximumZoomLevel, if specified. The default value for this option is 0.This option corresponds to the
minzoomkey in the TileJSON specification.Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionMinimumZoomLevelSwift
static let minimumZoomLevel: DingiTileSourceOption -
An
NSNumberobject containing an unsigned integer that specifies the maximum zoom level at which to display tiles from the source.The value should be between 0 and 22, inclusive, and less than
DingiTileSourceOptionMinimumZoomLevel, if specified. The default value for this option is 22.This option corresponds to the
maxzoomkey in the TileJSON specification.Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionMaximumZoomLevelSwift
static let maximumZoomLevel: DingiTileSourceOption -
An
NSValueobject containing anDingiCoordinateBoundsstruct that specifies the geographic extent of the source.If this option is specified, the SDK avoids requesting any tile that falls outside of the coordinate bounds. Otherwise, the SDK requests any tile needed to cover the viewport, as it does by default.
This option corresponds to the
boundskey in the TileJSON specification.Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionCoordinateBoundsSwift
static let coordinateBounds: DingiTileSourceOption -
An HTML string defining the buttons to be displayed in an action sheet when the source is part of a map view’s style and the map view’s attribution button is pressed.
By default, no attribution statements are displayed. If the
DingiTileSourceOptionAttributionInfosoption is specified, this option is ignored.This option corresponds to the
attributionkey in the TileJSON specification.Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionAttributionHTMLStringSwift
static let attributionHTMLString: DingiTileSourceOption -
An array of
DingiAttributionInfoobjects defining the buttons to be displayed in an action sheet when the source is part of a map view’s style and the map view’s attribution button is pressed.By default, no attribution statements are displayed.
Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionAttributionInfosSwift
static let attributionInfos: DingiTileSourceOption -
An
NSNumberobject containing an unsigned integer that specifies the tile coordinate system for the source’s tile URLs. The integer corresponds to one of the constants described inDingiTileCoordinateSystem.The default value for this option is
DingiTileCoordinateSystemXYZ.This option corresponds to the
schemekey in the TileJSON specification.Declaration
Objective-C
extern const DingiTileSourceOption _Nonnull DingiTileSourceOptionTileCoordinateSystemSwift
static let tileCoordinateSystem: DingiTileSourceOption
-
Indicates an error occurred in the Mapbox SDK.
Declaration
Objective-C
extern const NSErrorDomain _Nonnull DingiErrorDomainSwift
let DingiErrorDomain: String
-
An
NSStringidentifying thelinearinterpolation type in anNSExpression.This attribute corresponds to the
linearvalue in theinterpolateexpression operator in the Mapbox Style Specification.Declaration
Objective-C
extern const DingiExpressionInterpolationMode _Nonnull DingiExpressionInterpolationModeLinearSwift
static let linear: DingiExpressionInterpolationMode -
An
NSStringidentifying theexpotentialinterpolation type in anNSExpression.This attribute corresponds to the
exponentialvalue in theinterpolateexpression operator in the Mapbox Style Specification.Declaration
Objective-C
extern const DingiExpressionInterpolationMode _Nonnull DingiExpressionInterpolationModeExponentialSwift
static let exponential: DingiExpressionInterpolationMode -
An
NSStringidentifying thecubic-bezierinterpolation type in anNSExpression.This attribute corresponds to the
cubic-beziervalue in theinterpolateexpression operator in the Mapbox Style Specification.Declaration
Objective-C
extern const DingiExpressionInterpolationMode _Nonnull DingiExpressionInterpolationModeCubicBezierSwift
static let cubicBezier: DingiExpressionInterpolationMode
-
Project version number for Mapbox.
Declaration
Objective-C
extern double DingiMapVersionNumberSwift
var DingiMapVersionNumber: Double -
Project version string for Mapbox.
Declaration
Objective-C
extern const unsigned char DingiMapVersionString[]
-
The default deceleration rate for a map view.
Declaration
Objective-C
extern const DingiMapViewDecelerationRate DingiMapViewDecelerationRateNormalSwift
static let normal: DingiMapViewDecelerationRate -
A fast deceleration rate for a map view.
Declaration
Objective-C
extern const DingiMapViewDecelerationRate DingiMapViewDecelerationRateFastSwift
static let fast: DingiMapViewDecelerationRate -
Disables deceleration in a map view.
Declaration
Objective-C
extern const DingiMapViewDecelerationRate DingiMapViewDecelerationRateImmediateSwift
static let immediate: DingiMapViewDecelerationRate -
The default frame rate. This can be either 30 FPS or 60 FPS, depending on device capabilities.
Declaration
Objective-C
extern const DingiMapViewPreferredFramesPerSecond DingiMapViewPreferredFramesPerSecondDefaultSwift
static let `default`: DingiMapViewPreferredFramesPerSecond -
A conservative frame rate; typically 30 FPS.
Declaration
Objective-C
extern const DingiMapViewPreferredFramesPerSecond DingiMapViewPreferredFramesPerSecondLowPowerSwift
static let lowPower: DingiMapViewPreferredFramesPerSecond -
The maximum supported frame rate; typically 60 FPS.
Declaration
Objective-C
extern const DingiMapViewPreferredFramesPerSecond DingiMapViewPreferredFramesPerSecondMaximumSwift
static let maximum: DingiMapViewPreferredFramesPerSecond
Other Constants Reference